Fix inconsistent docstrings, missing arguments, and typos in models#2580
Fix inconsistent docstrings, missing arguments, and typos in models#2580AlejandroPG06 wants to merge 2 commits intokeras-team:masterfrom
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Summary of ChangesHello @AlejandroPG06, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the clarity and accuracy of the codebase by resolving various documentation inconsistencies and typographical errors within the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request provides a valuable set of fixes for documentation across various models. The changes correctly address typos in docstrings, comments, and error messages, and also add missing argument documentation to ensure consistency with the function signatures. The correction in the PaliGemmaBackbone code example is also accurate. All the changes are correct and improve the overall quality and clarity of the codebase. The pull request is good to merge.
This PR addresses several documentation inconsistencies and typographical errors across the src/models directory. It ensures that docstrings accurately reflect the init arguments and fixes common typos in comments and error messages.
Changes
Docstring Completeness
MistralBackbone: Added documentation for the dropout argument.
FluxBackbone: Added documentation for missing shape arguments (image_shape, text_shape, image_ids_shape, text_ids_shape, y_shape).
Code Example Fixes
PaliGemmaBackbone: Corrected images_size to image_size in the class docstring example to match the actual argument name.
Typo Fixes$\to$ rotary in GPT-OSS, Llama3, and Mixtral backbones.$\to$ triangular in Mixtral decoder.$\to$ Pooling in error messages for HGNetV2, VGG, and ImageClassifier (prevents confusing error messages for users).$\to$ done in float32 in ~14 files (CLIP, SigLIP, PaliGemma, Dino, etc.).$\to$ value used for in Gemma models.$\to$ function and polling $\to$ pooling.
Fixed roatary
Fixed traingular
Fixed Polling
Fixed done a float32
Fixed value user for
Fixed minor typos like fucntion
Verification
Verified that the updated docstrings match the function signatures.
Checked that no logic code was altered, only comments, docstrings, and error message strings.
Fixes #2579